Import and Export Users from/to File

Note: The primary use of this function is to export and import user accounts between two IceWarp Servers.

Tip: For transferring users to another IceWarp Server, we recommend to use the command line tool.exe.

This powerful feature lets you export accounts from the selected domain to a specially formatted text file (.mae for version 9.x or .exp for version 10.x).

The file includes all account types and account properties including its email address, account name, account type (as an integer value), password and properties (as an encoded string).

This file can be edited using a standard text editor.

The import feature lets you import accounts from the exported file.

There are some important points you should be aware of:

  • If a domain listed in the file is missing in IceWarp Serverit will be created automatically.
  • If any property values are not available, then account defaults will be used.

Warning: It is highly recommended that you experiment with this facility before you use it on any large number of accounts on a production server.

Note: When exporting/importing accounts, only account structures are exported/imported. Account data is not exported/imported. If you want to backup all account data, do it manually in the IceWarp/mail/{domain}/{user} directory.

To move one or several accounts from one domain to another, use the cut and paste method. To move all domain accounts from one domain to another, rename the domain - it keeps all data intact. (When renaming a domain, all services e.g.: GroupWare, Antispam, etc. must be running!)

  • File Structure: {address},{properties}
  • Example: fred@{demo.com},eJxjYGBg4AsuScxLSSxKUQgtTi2yhlAMIwYwspSOKP9igAH3PyOEctj5yGEgrB9w ... CUTAKRsHgAADS/h28

Tool.exe Commands:

Tool.exe is a command line interface for Windows to access the IceWarp Server API. For Linux it is tool.sh. To use it, navigate to the IceWarp Server installation root where it is located (usually you would type cd /Program Files/IceWarp/ or applicable location in Linux).

To export accounts, you can use this command (syntax followed by an example):

tool export account "*@{domain_name}" u_backup > {file_name}

tool export account "*@icewarp.com" u_backup > icewarp_com.csv

To import accounts, you can use this command (syntax followed by an example):

tool import account "{file_name}" u_name u_password u_comment

tool import account "domain_com.csv" u_name u_password u_comment

To reveal more commands, use this command (or refer to the Command Line Tool chapter):

tool - tutorial

Note: The backup/migration file suffix is .exp but in previous versions before 10.0.0 it was .mae. If you are exporting from an older version into .mae you can simply rename this file to .exp and it will be importable into the latest versions of IceWarp Server.

Import/Export of Accounts Via Console

To export accounts, do the following:

  1. In the Console, right-click name of the selected domain (Domains and Accounts > Management) and from the pop-up menu, select Import/Export > Export domain and account to file. The standard Save As dialog opens.
  2. Save the file e.g. as {domain_com}.exp.

To import accounts, do the following:

  1. In the Console, right-click name of the selected domain (Domains and Accounts > Management) and from the pop-up menu, select Import/Export > Export domain and account to file. The standard Open dialog opens.
  2. Select the appropriate file to import accounts.

Note: The name of the domain to which you import accounts should match the name of the domain from which you export accounts.

Imported accounts are added. This means that in case there are any other accounts in the domain, they will not be deleted.

It is recommended to export/import accounts only between same versions of IceWarp Server.

Export of Phone Numbers

If you export phone numbers of domain users, the numbers will be exported as a .csv file with the following information:

{Name}, {Email address}, {Phone number}

To export phone numbers, do the following:

  1. Right-click the appropriate domain name and select Export/Import > Export Phone # to CSV.
  2. In the standard Save As dialog, select the desired location and save the file.